/**
 * @(#)RolK.java 20/03/2006
 *
 * Copyright (c) 2005-2010 Psiqueware S.A. de C.V. All Rights Reserved.
 * This software is the proprietary information Psiqueware S.A. de C.V.
 * Use is subject to license terms.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * Usuario : Psique
 * Creaci&oacute;n: Desconocida
 * Cambios :
 *  Fecha | Autor  |  Cambios
 *  20/03/2006 | <a href = "mailto:AngelElectrico@PsiqueWare.com">Angel El&eacute;ctrico</a> | Se renombr&oacute; de RolImp a RolK.
 * <li>Ene 23, 2007 | <a href = "mailto:AngelElectrico@PsiqueWare.com">Angel El&eacute;ctrico</a> | Se port&oacute; la clase a Java5.</li>
 */

package com.psiqueware.alheli.seguridad.modelo;

import com.psiqueware.alheli.basico.BaseObject;
import com.psiqueware.alheli.seguridad.Agrupacion;
import com.psiqueware.alheli.seguridad.Permiso;
import com.psiqueware.alheli.seguridad.PermisoRol;
import com.psiqueware.alheli.seguridad.Rol;

import java.util.*;

/**
 * Conjunto de {@link Permiso}s que pertenecen a un {@link Agrupacion} dado.
 * <br/>Paquete Original: com.psiqueware.basico.seguridad.modelo
 * <br/>Nombre  Original: RolImp
 * <br/><a href="RolK.java.html"><i>Ver C&oacute;digo Fuente</i> </a>
 *
 * @author <a href="mailto:AngelElectrico@psiqueware.com">Angel El&eacute;ctrico</a>
 * @version Revision: 1.0 20/03/2006
 * @noinspection ClassWithoutLogger, ClassNamingConvention
 */
public final class RolK extends BaseObject implements Rol
{
    /**
     * Lista de los {@link Permiso} incluidos en este {@link Rol}.
     * <p><b>Importante: </b>
     * No se debe realizar una copia de la lista en el metodo setter, este metodo
     * se utiliza en el presidencial para tener una sola copia del listado de permisos con todos los permisos
     * en el sistema y optimizar la memoria.
     */
    private List<Permiso> m_permisos = new ArrayList<Permiso>();

    /**
     * Nombre del Rol
     */
    private String m_nombre;

    /**
     * {@link Agrupacion} al que pertenece este {@link Rol}.
     */
    private Agrupacion m_agrupacion;

    /**
     * &Iacute;dentificador &uacute;nico de la {@link Agrupacion} al que pertenece este {@link Rol}.
     */
    private Long m_idAgrupacion;

    /**
     * Listado de {@link PermisoRol}s que contienen los {@link Permiso} para este Rol.
     */
    private final List<PermisoRol> m_permisosRol = new ArrayList<PermisoRol>();

    /**
     * Construye una RolK.
     * No requiere argumentos.
     * Se utiliza solo para hibernate a fin de garantizar que el {@link Rol} se inicialize en un estado correcto
     * es necesario utilizar la operaci&oacute;n RolK(AgrupacionK,String).
     *
     * @see this#RolK(Agrupacion, String)
     */
    public RolK()
    {
    }

    /**
     * Construye un RolK.
     *
     * @param agrupacion del M&oacute;dulo que contiene dicho RolK.
     * @param nombre     del {@link Rol}.
     */
    public RolK(final Agrupacion agrupacion, final String nombre)
    {
        this.m_agrupacion = agrupacion;
        this.m_idAgrupacion = m_agrupacion.getId();
        this.m_nombre = nombre;
    }

    /**
     * Dice si se pose&eacute; un {@link Permiso}.
     *
     * @param permiso buscado.
     *
     * @return <code>true</code> si este Rol tiene dicho permiso; <code>false</code> en caso contrario.
     */
    boolean tienePermiso(Permiso permiso)
    {
        return this.m_permisos.contains(permiso);
    }

    /**
     * Devuelve el {@link PermisoRol} correspondiente a un {@link Permiso} dado.
     *
     * @param permiso {@link Permiso} cuyo {@link PermisoRol} se busca.
     *
     * @return {@link PermisoRol} si se encuentra;<code>null</code> en caso contrario.
     */
    public PermisoRol buscaPermisoRol(final Permiso permiso)
    {
        PermisoRol permisoRol = null;
        for (final PermisoRol pr : m_permisosRol)
        {
            if (pr.getPermiso().equals(permiso))
            {
                permisoRol = pr;
                break;
            }
        }
        return permisoRol;
    }

    /**
     * A&ntilde;ade un {@link PermisoRol} al listado m_permisosRol, que contienen los {@link Permiso} para este Rol.
     *
     * @param o {@link PermisoRol} a añadir.
     *
     * @return <tt>true</tt> (as per the general contract of the
     * <tt>Collection.add</tt> method).
     */
    public boolean addPermisoRol(final PermisoRol o)
    {
        m_permisos.add(o.getPermiso());
        return m_permisosRol.add(o);
    }

    /**
     * Remueve un {@link PermisoRol} del listado <code>m_permisosRol</code>, que contienen los {@link Permiso} para este Rol.
     *
     * @param o {@link PermisoRol} a eliminar.
     *
     * @return <tt>true</tt> if this list contained the specified element.
     */
    public boolean removePermisoRol(final PermisoRol o)
    {
        m_permisos.remove(o.getPermiso());
        return m_permisosRol.remove(o);
    }

    /**
     * Devuelve una copia del listado <code>m_permisosRol</code>, que contienen los {@link Permiso} para este Rol.
     *
     * @return una nueva List&lt;PermisoRol&gt;.
     */
    public List<PermisoRol> listPermisoRols()
    {
        return new ArrayList<PermisoRol>(m_permisosRol);
    }

    /**
     * Devuelve la Lista de los {@link PermisoRol} que contienen los {@link Permiso} para este Rol.
     *
     * @return List(unmodifiable) de 'm_permisosRol'.
     *
     * @see java.util.List
     */
    public List<PermisoRol> getPermisoRols()
    {
        return Collections.unmodifiableList(m_permisosRol);
    }

    /**
     * Establece los valores de la Lista de los {@link PermisoRol} que contienen los {@link Permiso} para este Rol.
     *
     * @param newList nuevo valor para 'm_permisosRol'. En caso de ser nulo se vaciar&aacute; el arreglo existente.
     *
     * @see java.util.List
     */
    public void setPermisoRols(final List<? extends PermisoRol> newList)
    {
        m_permisosRol.clear();
        m_permisos.clear();
        if (null != newList)
        {
            for (final PermisoRol permisoRol : newList)
            {
                addPermisoRol(permisoRol);
            }
        }
    }

    /**
     * Nos dice si el {@link PermisoRol} se encuentra contenido en la
     * lista.
     *
     * @param o {@link PermisoRol} a buscar.
     *
     * @return <code>true</code> si lo encuentra; <code>false</code> en caso contrario.
     */
    public boolean containsPermisoRol(final PermisoRol o)
    {
        return m_permisosRol.contains(o);
    }

    /**
     * Devuelve la lista con los {@link Permiso} asignados a este {@link Rol}.
     *
     * @return {@link List} de objetos {@link Permiso}.
     */
    public List<Permiso> listPermisos()
    {
        return m_permisos;
    }


    /**
     * Convierte este {@link Rol} a su representaci&oacute;n textual.
     *
     * @noinspection DuplicateStringLiteralInspection
     */
    public String toString()
    {

        StringBuilder sb = new StringBuilder();
        sb.append("<Instance Class = '").append(this.getClass().getName()).append("'>");
        sb.append("<id>").append(m_id).append("</id>");
        sb.append("<nombre>").append(m_nombre).append("</nombre>");
        if (null == m_agrupacion)
        {
            sb.append("<agrupacion>").append(m_agrupacion).append("</agrupacion>");
        }
        else
        {
            sb.append("<agrupacion>").append(m_agrupacion.getId()).append("</agrupacion>");
        }
        for (Permiso permiso : m_permisos)
        {
            sb.append("<permisos>").append(permiso).append("</permisos>");
        }
        sb.append("</Instance>");
        return sb.toString();
    }

    /**
     * Compara este objeto con otro.
     * Se sobrescribe la operaci&oacute;n por defecto por razones de velocidad.
     *
     * @param obj a ser igualado con este.
     *
     * @return <code>true</code> si los objeto son iguales; <code>false</code> en caso contrario.
     *
     * @noinspection CallToStringEquals, EqualsWhichDoesntCheckParameterClass, NonFinalFieldReferenceInEquals
     */
    public boolean equals(Object obj)
    {
        boolean salida;
        Rol that = (Rol) obj;
        if (this.getId() != null && that.getId() != null)
        {
            salida = this.getId().equals(that.getId());
        }
        else if (this.getNombre() != null)
        {
            salida = this.getNombre().equals(that.getNombre());
            if (m_agrupacion != null)
            {
                salida &= m_agrupacion.equals(that.getAgrupacion());
            }
        }
        else
        {
            salida = super.equals(obj);
        }
        return salida;
    }

    /**
     * Description of the Method
     *
     * @return Description of the Return Value
     */
    public int hashCode()
    {
        int salida;
        if (this.getNombre() != null)
        {
            salida = this.getNombre().hashCode();
        }
        else
        {
            salida = super.hashCode();
        }
        return salida;
    }


    /**
     * Realiza una comparaci&oacute;n de este objeto contra otro a fin de
     * realizar una ordenaci&oacute;n natural. De ser necesario alterar el
     * orden de objetos se factible sobrecargar esta operaci&oacute;n.
     *
     * @noinspection CallToStringCompareTo, unchecked
     * @see Comparable#compareTo
     */
    @Override
    public int compareTo(Object o)
    {
        int salida;
        Rol that = (Rol) o;
        if (this.getId() != null && that.getId() != null)
        {
            salida = super.compareTo(o);
        }
        else if (this.getNombre() != null)
        {
            salida = this.getNombre().compareTo(that.getNombre());
        }
        else
        {
            salida = super.compareTo(o);
        }
        return salida;
    }

    /**
     * Devuelve la {@link Agrupacion} que es due&ntilde;o de este {@link Rol}.
     */
    public Agrupacion getAgrupacion()
    {
        return m_agrupacion;
    }


    /**
     * Devuelve el m_nombre de este {@link Rol}
     */
    public String getNombre()
    {
        return m_nombre;
    }


    /**
     * Devuelve una copia de la Lista de los {@link Permiso} incluidos en este {@link Rol}.
     *
     * @return valor de 'permisos'.
     *
     * @noinspection ReturnOfCollectionOrArrayField
     * @see List<Permiso>
     */
    @Override
    public List<Permiso> getPermisos()
    {
        return Collections.unmodifiableList(m_permisos);
    }

    /**
     * M&eacute;todos de Uso para Hibernate
     *
     * @param nombre frl {@link Rol}.
     *
     * @noinspection UNUSED_SYMBOL
     */
    public void setNombre(String nombre)
    {
        m_nombre = nombre;
    }

    /**
     * M&eacute;todos de Uso para Hibernate
     *
     * @param agrupacion a establecer.
     *
     * @noinspection UNUSED_SYMBOL
     */
    public void setAgrupacion(Agrupacion agrupacion)
    {
        m_agrupacion = agrupacion;
        m_idAgrupacion = null == agrupacion ? null : agrupacion.getId();
    }

    /**
     * Devuelve el &Iacute;dentificador &uacute;nico de la {@link Agrupacion} al que pertenece este {@link Rol}.
     * @return Valor de 'm_idAgrupacion'.
     */
    public Long getIdAgrupacion()
    {
        return m_idAgrupacion;
    }

    /**
     * Establece el &Iacute;dentificador &uacute;nico de la {@link Agrupacion} al que pertenece este {@link Rol}.
     * @param idAgrupacion Nuevo valor para 'm_idAgrupacion'.
     */
    public void setIdAgrupacion(final Long idAgrupacion)
    {
        m_idAgrupacion = idAgrupacion;
    }
}
